From 7eadf458886588448c2615e1cf74668431e331f7 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Javier=20Jard=C3=B3n?= Date: Wed, 1 Sep 2010 19:36:19 +0200 Subject: [PATCH] gtktypeutils: move documentation to inline comments --- docs/reference/gtk/tmpl/.gitignore | 1 + docs/reference/gtk/tmpl/gtktypeutils.sgml | 51 ----------------------- gtk/gtktypeutils.c | 10 +++++ gtk/gtktypeutils.h | 25 ++++++++++- 4 files changed, 35 insertions(+), 52 deletions(-) delete mode 100644 docs/reference/gtk/tmpl/gtktypeutils.sgml diff --git a/docs/reference/gtk/tmpl/.gitignore b/docs/reference/gtk/tmpl/.gitignore index d19042e8db..c9a1746bfc 100644 --- a/docs/reference/gtk/tmpl/.gitignore +++ b/docs/reference/gtk/tmpl/.gitignore @@ -34,4 +34,5 @@ gtktextiter.sgml gtktoggleaction.sgml gtktoolitem.sgml gtktreednd.sgml +gtktypeutils.sgml gtkwindow.sgml diff --git a/docs/reference/gtk/tmpl/gtktypeutils.sgml b/docs/reference/gtk/tmpl/gtktypeutils.sgml deleted file mode 100644 index 69a4a26520..0000000000 --- a/docs/reference/gtk/tmpl/gtktypeutils.sgml +++ /dev/null @@ -1,51 +0,0 @@ - -Types - - -Handle run-time type creation - - - -The GTK+ type system is extensible. Because of that, types have to be -managed at runtime. - - - - - - - - - - - - - - - -Defines a function pointer. - - -@data: #gpointer -@Returns: #gint - - - - -Defines a function pointer. - - -@object: #GtkObject* -@data: #gpointer -@n_args: #guint -@args: #GtkArg* - - - - -This is a structure that we use to pass in typed values (and names). - - -@type: -@name: - diff --git a/gtk/gtktypeutils.c b/gtk/gtktypeutils.c index 1d6f9b44e4..ea30f06e67 100644 --- a/gtk/gtktypeutils.c +++ b/gtk/gtktypeutils.c @@ -32,6 +32,16 @@ #include "gtkintl.h" +/** + * SECTION:gtktypeutils + * @Short_description: Handle run-time type creation + * @Title: Types + * + * The GTK+ type system is extensible. Because of that, types have to be + * managed at runtime. + */ + + GType gtk_identifier_get_type (void) { diff --git a/gtk/gtktypeutils.h b/gtk/gtktypeutils.h index 75711a3f4a..883266e116 100644 --- a/gtk/gtktypeutils.h +++ b/gtk/gtktypeutils.h @@ -47,7 +47,26 @@ GType gtk_identifier_get_type (void) G_GNUC_CONST; */ typedef struct _GtkArg GtkArg; typedef struct _GtkObject GtkObject; /* object forward declaration */ + +/** + * GtkFunction: + * @data: #gpointer + * + * Defines a function pointer. + * + * Returns: #gint + */ typedef gboolean (*GtkFunction) (gpointer data); + +/** + * GtkCallbackMarshal: + * @object: #GtkObject* + * @data: #gpointer + * @n_args: #guint + * @args: #GtkArg* + * + * Defines a function pointer. + */ typedef void (*GtkCallbackMarshal) (GtkObject *object, gpointer data, guint n_args, @@ -60,7 +79,11 @@ typedef gchar * (*GtkTranslateFunc) (const gchar *path, gpointer func_data); #if defined (GTK_COMPILATION) -/* GtkArg, used to hold differently typed values */ +/** + * GtkArg: + * + * This is a structure that we use to pass in typed values (and names). + */ struct _GtkArg { GType type; -- 2.30.2